Customizing the Development Environment Previous Up
Customizing the Development Environment



Wizard Definition Page Library

A set of seven page definition files is available in ColdFusion Studio and JRun Studio. The library can be used to quickly build data access capabilities into wizards.

This section is included for HomeSite users who may want to upgrade to use these additional features.

SelectNameAndLocation

This page collects application name and location where the destination directory for the output templates. It allows the user to select the directory from the local or remote server. This page is required if any of the following pages are included in the wizard.

Exposes controls

editApplicationName (textbox) -- After the page is submitted, the content of this textbox are copied to the SafeApplicationName parameter with all non-allowed characters stripped out. This value can be then used as part of the file names.

editLocation (textbox) -- This control should be bound to the Location parameter. The value of this parameter is preset to the directory opened in the left pane.

Example

<PAGE name="SelectWizardNameAndLocation" type="SelectNameAndLocation" 
caption="Data Drill-Down Application" 
image="..\\images\\Main.bmp">



    <INPUT name="editApplicationName" param="ApplicationName"

        required="yes"

        validationMsg="You cannot leave the Application Name field

        blank">



    <INPUT name="editLocation" param="Location"    required="yes"

        validationMsg="You cannot leave the Location field blank">



</PAGE>

SelectDataSource

This page displays a list of available data sources on the selected local or remote server.

Uses controls

cbDataSources (dropdown) -- This control lists all available data sources. The control exchanges with the bound parameter the name of the selected data source.

Reads parameters

ListBoxLabel -- Caption for the dropdown control.

ListBoxDescription -- More detailed description for the dropdown control.

ResetParams -- Comma-delimited list of parameters that should be emptied if user reselects the data source.

RemoveParams -- Comma-delimited list of parameters that should be removed if user reselects the data source.

Example

<PAGE name="DataSource" type="SelectDataSource" caption="Data Source"

    image="..\\images\\SelectData.bmp">



    <PARAM name="ListBoxLabel" value="Select data source:">

    <PARAM name="ListBoxDescription"

        value="Choose the data source from which you would like to 
display

        data.\n\nIf your database is not registered as ODBC data 
source,

        open the ODBC administrator in Control Panel and add system 
data

        source for this database.">

    <PARAM name="ResetParams" value="Joins">

    <PARAM name="RemoveParams" 
value="Tables,SearchFields,ResultFields,

        DetailFields,UniqueIdentifier">



    <INPUT name="cbDataSources" param="DataSource" 
required="yes"

        validationMsg="You did not select the data source. Please 
select

        one before proceeding.">



</PAGE>

SelectTables

This page displays a list of tables in the specified data source and lets the user select one or more of them.

Exposes controls

lstTables (dropdown) -- The control lists tables in the data source specified in the DataSource parameter. The control exchanges with the bound parameter a comma-delimited list of selected tables.

Reads parameters

DataSource (required) -- Name of the data source.

ListBoxLabel -- Caption for the dropdown control.

ListBoxDescription -- More detailed description for the dropdown control

MultiSelect -- If "YES", user is allowed to select more than one table.

ResetParams -- Comma-delimited list of parameters that should be emptied if user reselects the tables.

RemoveParams -- Comma-delimited list of parameters that should be removed if user reselects the tables.

Example

<PAGE name="Tables" type="SelectTables" caption="Tables"

    image="..\\images\\SelectTable.bmp">



    <PARAM name="DataSource" value="$${DataSource}">

    <PARAM name="ListBoxLabel" value="Select database tables:">

    <PARAM name="ListBoxDescription"

        value="Please specify the tables which will be involved in 
this

        application. This should include any tables against which 
you

        would like to search or tables containing data that will be

        displayed on either the Result or Detail pages.\n\nPress 
Ctrl or

        Shift together with the mouse click in order to select more 
than

        one table. Do not select unrelated tables.">

    <PARAM name="MultiSelect" value="yes">

    <PARAM name="ResetParams" value="Joins">

    <PARAM name="RemoveParams" value="SearchFields,ResultFields,

        DetailFields,UniqueIdentifier">



    <INPUT name="lstTables" param="Tables" required="yes" 

        validationMsg="You did not select any tables. Please select 
at

        least one before proceeding.">



</PAGE>

SelectTable

This page lets the user select one of the tables from the specified data source.

Exposes controls

cbTables (dropdown) -- The control lists tables in the data source specified in the DataSource parameter.

The control exchanges with the bound parameter the name of the selected table.

Reads parameters

DataSource (required) -- Name of the data source.

ListBoxLabel -- Caption for the dropdown control.

ListBoxDescription -- More detailed description for the dropdown control.

ResetParams -- Comma-delimited list of parameters that should be emptied if user reselects the table.

RemoveParams -- Comma-delimited list of parameters that should be removed if user reselects the table.

Example

<PAGE name="Table" type="Table" caption="Table"

    image="..\\images\\SelectTable.bmp">



    <PARAM name="DataSource" value="$${DataSource}">

    <PARAM name="ListBoxLabel" value="Select database table:">

    <PARAM name="ListBoxDescription"

        value="Records from this table will be displayed in the 
record

        viewer.">

    <PARAM name="RemoveParams" 
value="Table,ViewFields,EditFields,

        UniqueIdentifier">


    <INPUT name="cbTables" param="Table" required="yes"

        validationMsg="You didn't select the table. Please select 
one

        before proceeding.">



</PAGE>

SelectTableJoins

The page lets the user select fields from multiple tables for table joins.

Exposes controls

lstJoins (dropdown) -- The control lists field pairs as selected from the dropdown field lists. This list can be pre-filled from the comma delimited list of items, where each item has format "table1.field1=table2.field2".

Reads parameters

DataSource (required) -- Name of the data source.

Tables (required) -- Comma-delimited list of the tables.

ListContent (required) -- Input parameter.

Example

<PAGE name="TableJoins" type="SelectTableJoins" caption="Table Joins" 
image="..\\images\\SelectJoins.bmp">



    <PARAM name="DataSource" value="$${DataSource}">

    <PARAM name="Tables" value="$${Tables}">

    <PARAM name="ListContent" value="$${Joins}">



    <INPUT name="lstJoins" param="Joins">



</PAGE>

SelectFields

This page displays all fields from the specified tables and lets the user select one or more of them.

Exposes controls

lstFields (dropdown) -- The control lists fields in the tables specified in the Tables parameter. The control exchanges with the bound parameter a comma-delimited list of selected fields, where each item is in format "table.field=type,size,required". Type specifies the type of the table field can have following values (BIT, CHAR, MEMO, INT, FLOAT, DATETIME. Size gives information about size of the field in bytes (this might not be true for certain DBMS and types). Required is "YES" if the field value cannot be NULL.

Reads parameters

DataSource (required) -- Name of the data source.

Tables (required) -- Comma-delimited list of the tables.

ListBoxLabel -- Caption for the dropdown control.

ListBoxDescription -- More detailed description for the dropdown control.

MultiSelect -- If "YES", user is allowed to select more than one field.

Example

<PAGE name="SearchFields" type="SelectFields" caption="Fields for Search

    page" image="..\\images\\SearchCriteria.bmp">



    <PARAM name="DataSource" value="$${DataSource}">

    <PARAM name="Tables" value="$${Tables}">

    <PARAM name="ListBoxLabel" value="Select the search 
fields:">

    <PARAM name="ListBoxDescription" 

        value="Choose all fields that should be included as search

        criteria on the Search page. Press Ctrl or Shift together 
with the

        mouse click in order to select more than one field.">

    <PARAM name="MultiSelect" value="yes">



    <INPUT name="lstFields" param="SearchFields" required="yes"

        validationMsg="You did not select any fields. Please select 
at

        east one before proceeding.">



</PAGE>

SelectField

This page lets the user select one field from the list of fields. The list of fields contains all fields from the specified tables.

Exposes controls

cbFields (required) -- The control lists fields in the tables specified in the Tables parameter. The control exchanges with the bound parameter the field information in the format "table.field=type.size.required" (see the SelectFields page)

Reads parameters

DataSource (required) -- Name of the data source.

Tables (required) -- Comma-delimited list of tables.

ListBoxLabel -- Caption for the dropdown control.

ListBoxDescription -- More detailed description for the dropdown control.

Example

<PAGE name="IDField" type="SelectField" caption="Unique Identifier"

    image="..\\images\\UniqueIDDetail.bmp">



    <PARAM name="DataSource" value="$${DataSource}">

    <PARAM name="Tables" value="$${Tables}">

    <PARAM name="ListBoxLabel" value="Select the unique 
identifier for

        the Detail page:">

    <PARAM name="ListBoxDescription" value="In order to 
'drill-down' to

        the detail page the wizard needs to know the unique 
identifier for

        the detail page. This is the field that determines which 
record

        should be displayed in detailed form.\n\nFor example, if you 
are

        building an application to search an employee database you 
might

        use a field called 'Employee_ID' as the unique identifier.">

    <PARAM name="MultiSelect" value="no">



    <INPUT name="cbFields" param="UniqueIdentifier" 
required="yes"

        validationMsg="You did not select the unique identifier. 
Please

        select one before proceeding.">



</PAGE>



Copyright © 2000, Allaire Corporation. All rights reserved. Previous Up